Visualization Element: Frame

Symbol:

Category: Basic

The element serves as a frame in which to display one or more already existing visualizations. You get a structured user interface. The size of the frame can be fixed or scaled. The display area of the referenced visualization then adapts itself to the frame size.

Note

Kann auch veraltet sein Sample project: "Visualization Switching"

Element properties

Are all element properties available?

All properties are available only after you select the Advanced option or the All categories filter in Properties.

Element name	Example: `refVisUserInfo` Tip Assign individual names for elements so that they are found faster in the element list.
Element Type	Frame
Clipping	: Fixed size. Only that part of the referenced visualization that fits inside the frame is displayed. Requirement: The Scaling type property is Fixed.
Show frame	. Displays the frame No frame: The displayed area of the frame does not have borders. Frame: The displayed area of the frame has borders. No frame with offset: The displayed area of the frame does not have a border and the displayed area of the referenced visualization is reduced inwards by one pixel as compared to the frame area. The gap prevents the referenced visualization from touching any adjacent elements.

Position

The position defines the location and size of the element in the visualization window. This is based on the Cartesian coordinate system. The origin is located in the upper left corner of the window. The positive horizontal X-axis runs to the right. The positive vertical Y-axis runs downwards.

X	The X-coordinate (in pixels) of the upper left corner of the element Example: `10`
Y	The Y-coordinate (in pixels) of the upper left corner of the element Example: `10`
Width	Specified in pixels Example: `150`
Height	Specified in pixels Example: `30`
Angle	Requirement: This property is available only when you have selected the Support client animations and overlay of native elements option in the Visualization Manager. Value for angle (in degrees) Example: `25` Note The view in offline mode can differ slightly from the view in online mode.

Tip

You can also change the values by dragging the box symbols to other positions in the editor.

Are all element properties available?

All properties are available only after you select the Advanced option or the All categories filter in Properties.

Tip

Assign individual names for elements so that they are found faster in the element list.

Scaling type

Scaling type	Defines the scaling of the height and width of the referenced visualization The visualization is displayed in either a frame or a tab element.
Isotropic	The visualization is scaled to the size of the element to be displayed. With a fixed height-to-width ratio, the visualization retains its proportions.
Anisotropic	The visualization is scaled to the size of the element to be displayed. The height and width are each individually scaled to the element.
Fixed	The visualization is displayed in its original size, regardless of the dimensions of the element to be displayed.
Scroll Bar	The visualization is displayed in the element without any scaling. If it is larger than the element, then the element is provided with a scroll bar. Note: Assign variables to the properties Scrollposition variable horizontal or Scrollposition variable vertical. You can process the data for the scroll bar position in the application.
Dynamic scrollable	The size of the visualization is calculated dynamically and cyclically. When the size is calculated, the visibility of the elements of the referenced visualization is taken into account. The scroll bars are displayed only in case the contents of the referenced visualization cannot be fully displayed in the frame area after the dynamic calculation.

Deactivation of the background drawing

: The non-animated elements of the referenced visualization are displayed as background images (background frame) in order to optimize the performance of the visualization.

The advantage is that background elements, such as colored rectangles, are drawn once in the background.

standard icon : Deactivates the background display in order to prevent the behavior described above.

It can become problematic if another element (of the main page) is supposed to run behind this background frame. In this rare case, it makes sense to set this option so that the rectangle actually runs behind it.

Note

The property is available for the following settings:

The client animation functionality is not enabled: In the Visualization Manager, on the Settings tab, the Support client animations and overlay of native elements option is not selected.
When the client animation is enabled, the background drawing is automatically executed.
The Scaling type property is set to Scrollable.

Swiping

With this feature, the visualizations referenced in the element (Frame or Tabs) can be toggled by means of a swipe gesture (pan or flick gesture).

Swiping behavior

Requirement: Swiping is possible only when the Multitouch handling option is selected.

Options for how a visualization user needs to perform the swipe (pan or flick gesture) to trigger an image change to the next referenced visualization in the element:

Horizontal swiping: Swiping from right to left, and vice versa
Vertical swiping: Swiping from top to bottom, and vice versa
Not swipable: Swiping is disabled (default)

Hint: Set the scaling type to Anisotropic.

Swiping preview

Requirement: The option is available only in overlay mode (Support client animations and overlay of native elements option) to display the preview images on multitouch devices.

: During the swipe gesture, a preview image of the next visualization is displayed in the frame.

For more information, see: Referencing of Visualizations or Settings

References

Contains the currently configured visualization references as a subnode

Configure Button

Opens the Frame Configuration dialog. The dialog allows you to manage the referenced visualizations.

References

Warning

Visualizations can be nested at any depth by means of Frame elements. In order to use the Switch to any visualization frame selection type without any problems, a frame must not contain more than 21 referenced visualizations. For more information, see also the description for the Input configuration of an element: Action Switch frame visualization.

List of the currently referenced visualizations

Visualizations that have a button also have this displayed as a subnode. Each interface variable is listed with the currently assigned transfer parameters.

Example:

. vis_FormA

iDataToDisplay_1 : PLC_PRG.iVar1
iDataToDisplay_2 : PLC_PRG.iVar2

Tip

You can change the assignment of the variables to an interface variable here and edit the value field. Or click the Configure button instead.

Position

X	The X-coordinate (in pixels) of the upper left corner of the element Example: `10`
Y	The Y-coordinate (in pixels) of the upper left corner of the element Example: `10`
Width	Specified in pixels Example: `150`
Height	Specified in pixels Example: `30`
Angle	Requirement: This property is available only when you have selected the Support client animations and overlay of native elements option in the Visualization Manager. Value for angle (in degrees) Example: `25` Note The view in offline mode can differ slightly from the view in online mode.

Tip

You can also change the values by dragging the box symbols to other positions in the editor.

Center

	The properties contain fixed values for the coordinates of the point of rotation. The rotation point is displayed in the editor as the symbol and is used as the center for rotation and scaling. Tip You can also change the values by dragging the symbol to another position in the editor.
X	X-coordinate of the point of rotation
Y	Y-coordinate of the point of rotation

Colors

The properties contain fixed values for the text colors.

Color

Color of the frame

: List box with style colors opens

: Color standard dialog opens for a color selection

Note

Normal state is when the Boolean variable in the Color variables element property is not defined or its value is FALSE.

Alarm color

Color for the element in alarm state

Note

Alarm condition is when the value of the Boolean variable in the Color variables → Toggle color element property is FALSE.

Transparency

Integer (value range from 0 to 255). Determines the transparency of the respective color

255: The color is opaque.

0: The color is completely transparent.

Note

If the color is a style color and already has a transparency value, then this property is write-protected.

Appearance

The properties contain fixed values for setting the look of the element.

Line width

Value (in pixels)

Example: 2

Note

The values 0 and 1 both result in a line weight of one pixel. If no line should be displayed, then the Line style property has to be set to the Invisible option.

Line style

Type of line representation

Solid
Dash
Dots
Dash Dot
Dash Dot Dot
Invisible

Tip

You can assign variables in the Appearance variables property for controlling the appearance dynamically. The fixed values are defined here.

Texts

Text	String (without single straight quotation marks) Example: `Main page %i` The element is labeled with this text. If a placeholder `%<format string>` is specified in the text, then the value of the variable in the Text variable → Text property is output at the location of the placeholder.

Tip

Use the Ctrl+Enter shortcut to add a line break.

Tip

The specified texts are automatically transferred to the GlobalTextList text list. Therefore, these texts can be localized.

Text properties

The properties get fixed values for the text properties and act on the texts configured in Texts → Text or Texts → Tooltip.

Horizontal alignment	Horizontal alignment of the text within the element
Vertical alignment	Vertical alignment of the text within the element
Text format	. Definition for displaying texts that are too long Default: The text which is too long is truncated. Line break: The text is split into lines. Ellipsis: The visible text ends with "..." indicating that it is not complete.
Font	Example: Default : The Font dialog opens. : List box with style fonts
Font color	Example: Black : The Color dialog opens. : List box with style colors
Transparency	Integer (value range from `0` to `255`) The transparent value determines the transparency of the respective color. `255`: The color is opaque. `0`: The color is completely transparent. Note If the color is a style color and already has a transparency value, then this property is write-protected.

Absolute movement

The properties can be assigned to IEC variables for controlling the position of the element dynamically. The reference point is the upper left corner of the element. At runtime, the entire element is moved.

Movement
X	Variable (numeric data type) for the X-position (in pixels) Example: `PLC_PRG.iPos_X` Container variable: `Container.Width` For more information, see: Optimally Adjusting the Position and Size Increasing this value at runtime moves the element to the right.
Y	Variable (numeric data type) for the Y-position (in pixels) Example: `PLC_PRG.iPos_Y` Container variable: `Container.Height` For more information, see: Optimally Adjusting the Position and Size Increasing this value at runtime moves the element downwards.
Rotation	Variable (numeric data type) for the angle of rotation (in degrees) Example: `PLC_PRG.iAngle1` The midpoint of the element rotates at the Center point. This rotation point is shown as the symbol. At runtime, the alignment of the element remains the same with respect to the coordinate system of the visualization. Increasing the value rotates the element to the right.
Interior rotation	Variable (numeric data type) for the angle of rotation (in degrees) Example: `PLC_PRG.iAngle2` At runtime, the element rotates about the point of rotation specified in Center according to the value of the variable. In addition, the alignment of the element rotates according to the coordinate system of the visualization. Increasing the value in the code rotates clockwise. The rotation point is shown as the symbol. Note If a static angle of rotation is specified in the Position → Angle property, then the static angle of rotation is added to the variable angle of rotation (offset) when the visualization is executed.

Tip

You can combine the variables to a Unit conversion.

Tip

The X, Y, Rotation, and Interior rotation properties are supported by the "Client Animation" functionality.

Relative movement

The properties contains variables for moving the element. The reference point is the position of the element (Position property). The shape of the element can change.

Movement top-left
X	Variable (integer data type) for the number (in pixels) which the left edge is moved horizontally Example: `PLC_PRG.iDeltaX` Incrementing the value moves the element to the right.
Y	Variable (integer data type)for the number (in pixels) which the top edge is moved vertically Example: `PLC_PRG.iDeltaY` Incrementing the value moves the element to the down.
Movement bottom-right
X	Variable (integer data type) for the number (in pixels) which the right edge is moved horizontally. Example: `PLC_PRG.iDeltaWidth` Container variable: `Container.Width` For more information, see: Optimally Adjusting the Position and Size Incrementing the value moves the element to the right.
Y	Variable (integer data type)for the number (in pixels) which the bottom edge is moved vertically Example: `PLC_PRG.iDeltaHeight` Container variable: `Container.Height` For more information, see: Optimally Adjusting the Position and Size Incrementing the value moves the element to the down.

Text variables

Text variable

Variable (data type conforming to the formatting specification) for the placeholder in the Texts → Text property

Example: PLC_PRG.iAccesses

The variable value replaces the placeholder in the text of the element. At runtime, the element is labeled with the text, and the variable value is constantly updated.

Note

If you specify a variable of type enumeration with text list support, then the name of the enumeration data type is added automatically in angle brackets after the variable name. Example: PLC_PRG.enVar <enumeration name>. Then the symbolic value of the enumeration component is printed instead of the numeric value when text is printed. See the help page for enumerations.

Tooltip variable

Variable (data type conforming to the formatting specification) for the placeholder in the Texts → Tooltip property

Example: PLC_PRG.iAccessesInTooltip

The variable value replaces the placeholder in the tooltip of the element. At runtime, the tooltip is displayed and the variable value is constantly updated.

Dynamic texts

Dynamic texts are variably indexed texts of a text list. At runtime, the text is displayed that is currently indexed in the variable.

Text List

. Name of the text list

As a variable (STRING)
As fixed string literal with single straight quotation marks
Example: 'Errorlist'

: List box with the dialogs available in the text lists

Note: If a text list from the project is transferred to a visualization in a library, then a dot has to be prepended to the name of the text list.

Text index

. Text list ID which refers to the desired output text

As fixed string with the ID in single straight quotation marks
Example: '1'
As a variable (STRING) for dynamically controlling the text output
Example: strTextID
Sample assignment: PLC_PRG.strTextID := '1';

Tooltip index

. Text list ID which refers to the desired output text

As fixed string with the ID in single straight quotation marks
Example: '2'
As a variable (STRING) for dynamically controlling the text output
Example: strToolTipID
Sample assignment: PLC_PRG.strToolTipID := '2';

Font variables

The variables allow for dynamic control of the text display.

Font name	Variable (`STRING`) for the font of the text Example: `PLC_PRG.stFontVar := 'Arial';` Tip You can find out which fonts are available in the standard Font dialog.
Size	Variable (numeric data type) for the font size (in pixels or points) The applied unit is specified in brackets after the variable name. <pt>: Points (default) Example: `PLC_PRG.iFontHeight <pt>` Code: `iFontHeight : INT := 12;` <px>: Pixels Example: `PLC_PRG.iFontHeight <px>` Code: `iFontHeight : INT := 19;` Tip The font size is specified in points (example: Arial 12). Use points when the variable font size should match a font, for example if a font is set in the Text property → Font property. Tip If you click in the value field, a list box opens on the right for setting the unit.
Flags	Variable (`DWORD`) for the flags to determine the font display . Flags: `1`: Italics `2`: Bold `4`: Underline `8`: Strikethrough Note You can combine the font displays by adding the coding of the flags. For example, a bold and underlined text: `PLC_PRG.dwFontType := 6;`
Font	Variable (`DWORD`) for the character set number of the font The selection of character set numbers corresponds to the Script setting of the standard Font dialog.
Color	Variable (`DWORD`) for the color of the text Example: `PLC_PRG.dwColorFont:= 16#FF000000;`
Flags for text alignment	Variable (integer data type) for coding the text alignment Example: `PLC_PRG.dwTextAlignment` . Coding: `0`: Top left `1`: Horizontal center `2`: Right `4`: Vertical center `8`: Bottom Note You can combine the text alignments by adding the coding of the flags. For example, a vertical and horizontal centered text: `PLC_PRG.dwFontType := 5;`

Tip

Fixed values for displaying texts are set in Text properties.

Color variables

The Element property is used as an interface for project variables to dynamically control colors at runtime.

Toggle color

Variable (BOOL) for the color toggling

. Value assignment:

FALSE: The element is displayed with the color specified in the Color property.
TRUE: The element is displayed with the color specified in the Alarm color property.

. Assigning the property:

Placeholder for the user input variable of the input configuration
- <toggle/tap variable>
- <NOT toggle/tap variable>
The color change is not controlled by its own variable, but by a user input variable.
Note
Specify a variable for the mouse events Tap or Toggle in the input configuration. Only then is the placeholder set. If you configure a variable in both Toggle and Tap, then the variable specified in Tap is used.
Tip
Click the symbol to insert the <toggle/tap variable> placeholder.
Then when you activate the Input configuration, Tap FALSE property, the <NOT toggle/tap variable> placeholder is displayed.
Instance path of a project variable (BOOL)
Example: PLC_PRG.xColorIsToggeled
Note
In the code, declare and implement the variable which is specified here whose value assignment determines when the color changes.

Color

Color variable for the frame

Variable (DWORD) for the color
Example: PLC_PRG.dwColor
Color literal
Example of gray and opaque: 16#FF888888

Requirement: Show frame property is activated.

Note

The normal state is in effect if the expression in the Color variables → Toggle color property is not defined or it has the value FALSE.

Alarm color

Color variable for the frame in alarm state

Variable (DWORD) for the alarm color
Example: PLC_PRG.dwAlarmColor
Color literal
Example of red and opaque: 16#FFFF0000

Note

The alarm state is in effect if the expression in the Color variables → Toggle color property has the value TRUE.

Tip

The transparency part of the color value is evaluated only if the Visualization ManagerActivate semi-transparent drawing option of the visualization manager is selected.

Tip

In the toolbar of the Properties, select the Advanced option. Then all element properties are visible.

Look variables

The properties contain variables for controlling the appearance of the element dynamically.

Line width	Variable (integer data type) for the line width (in pixels) Note The values 0 and 1 both result in a line weight of one pixel. If no line should be displayed, then the Line style property has to be set to the Invisible option.
Line style	Variable (DWORD) for the line type . Coding: `0`: Solid line `1`: Dashed line `2`: Dotted line `3`: Line type "Dash Dot" `3`: Line type "Dash Dot Dot" `8`: Invisible: The line is not drawn.

Tip

Fixed values can be set in the Appearance property. These values can be overwritten by dynamic variables at runtime.

Toggle variable

Variable

The variable controls the switching of the referenced visualizations: The variable indexes one of the referenced frame visualizations and this is displayed in the frame. When the value of the variable changes, it switches to the recently indexed visualization.

Variable (integer data type) that contains the index of the active visualization
Example: PLC_PRG.uiIndexVisu
Tip
The Frame Configuration dialog includes a list of referenced visualizations. The visualizations are automatically numerically indexed via the order in the list. Adapt the order of the frame visualizations to generate the desired index.
Note
This variant of switching usually affects all connected display variants.
Array element (integer data type) for index access via CURRENTCLIENTID
Example: PLC_PRG.aIndexVisu[CURRENTCLIENTID]
Note
This variant of switching applies to the current client only, and therefore only on one display variant. That is the display variant where the value change was triggered (for example, by means of user input).

State variables

The variables control the element behavior dynamically.

Invisible

Variable (BOOL) for toggling the visibility of the element

TRUE: The element is not visible at runtime.

Tip

The Invisible property is supported by the "Client Animation" functionality.

Animation

Tip

These properties are available only when you have selected the Support client animations and overlay of native elements option in the Visualization Manager.

Animation duration

Variable for the duration (in milliseconds) in which the element runs an animation

Variable (integer value)
Example: Menu.tContent with VAR tContent : INT := 500; END_VAR
Integer literal
Example: 500

. Animatable properties

Absolute movement, Movement, X, Y
Absolute movement, Rotation
Absolute movement, Interior rotation
Absolute movement, Exterior rotation

The animated movement is executed when at least one value of an animatable property has changed. The movement then executed is not jerky, but is smooth within the specified animation duration. The visualization element travels to the specified position while rotating dynamically. The transitions are smooth.

Move to foreground

Variable (BOOL) for setting the element in the foreground

TRUE: At runtime, the visualization element is displayed in the foreground.

FALSE: At runtime, the visualization element is displayed in the layer where it was inserted in the visualization editor.

Example: bIsInForeground with VAR bIsInForeground : BOOL := FALSE; END_VAR

Input Configuration

The properties contain the configurations for the user input when using the mouse or keyboard. A user input defines an event and one or more actions that are executed when an event occurs.

Tip The Configure button opens the Input Configuration dialog. There you can create or edit user inputs. Configured user inputs are listed below the events. They each include the action that is triggered and the setting in short form. Example: Execute ST Code: `PLC_PRG.i_x := 0;`
OnDialogClosed	Input event: The user closes the dialog.
OnMouseClick	Input event: The user clicks the mouse button completely in the element area. The mouse button is clicked and released.
OnMouseDown	Input event: The user clicks down on the mouse button.
OnMouseEnter	Input event: The user drags the mouse pointer to the element.
OnMouseLeave	Input event: The user drags the mouse pointer away from the element.
OnMouseMove	Input event: The user moves the mouse pointer over the element area.
OnMouseUp	. Input events: The user releases the mouse button within the element area. It is irrelevant whether the user has previously pressed the mouse button inside or outside the element area. The user presses the mouse button within the element area, leaves the element area, and then releases the mouse button. Note This CODESYS-specific triggering behavior guarantees that actions for key elements are completed. A key element starts an action for OnMouseDown and ends the action for OnMouseUp. Example: A visualization user presses the mouse button within the element area of the key element and then moves the cursor position so that it is located outside of the element area. The action is ended anyway because OnMouseUp is triggered.
OnValueChanged	Event which triggers follow-up actions due to a change in value Which follow-up actions are triggered is configured in the Input Configuration dialog. The defined follow-up actions and the corresponding configuration are displayed below the element property. The OnValueChanged event can be disabled by the VISU_NO_VALUECHANGED compiler define in the properties dialog of the application.

Tap	When a mouse click event occurs, the variable defined in Variable is described in the application. The coding depends on the Tap FALSE and Tap on enter if captured options.
Variable	Requirement: The Tap FALSE option is not activated. Variable (`BOOL`) for the mouse click event `TRUE`: A mouse click event exists. It lasts as long as the user presses the mouse button over the element. It ends when the button is released. `FALSE`: A mouse click event does not exist. Example: `PLC_PRG.bIsTapped`
Tap FALSE	: The mouse click event leads to a complementary value in Variable. `TRUE`: A mouse click event does not exist. `FALSE`: While the mouse click event exists.
Tap on enter if captured	: During user input, it is also taken into consideration whether the mouse pointer is dragged within the element area or not while the mouse button is pressed. `TRUE`: While the mouse click event exists and the mouse pointer is moved over the element area. `FALSE`: A mouse click event does not exist. Or the user moves the mouse pointer outside of the element area while the mouse button is pressed. The value is `TRUE` again as soon as the user moves the pointer back to the element area. The mouse is then captured.

Switch over

With the onset of a mouse click event, the variable is set; when the mouse click event is completed, the variable is reset.

Variable

Variable (BOOL) for toggling at the end of the mouse click event

This is when the user releases the mouse button while the mouse pointer is over the element area. If the user releases the mouse button while the mouse pointer is outside of the element area, then the mouse click event is not ended and the value is not toggled.

Tip

The user can cancel a started toggle input by dragging the mouse pointer out of the element area.

Toggle on up if captured

standard icon : The value toggles regardless of where the mouse pointer is when the mouse button is released. The mouse is then captured.

Hotkey	Shortcut on the element for triggering specific input actions When the hotkey event occurs, the input actions in the Events property are triggered. In this way, it is not the input action itself that leads to this input action, but the mouse input action.
Key	Key pressed for input action. Example: T The following properties appear when a key is selected.
Events	None Mouse down: Pressing the key triggers the input actions that are configured in the OnMouseDown property. Mouse up: Releasing the key triggers the input actions that are configured in the OnMouseUp property. Mouse down/up: Pressing and releasing the key triggers the input actions that are configured in the OnMouseDown property and the OnMouseUp property.
Switch over	: Combination with the "Shift" key Example: Shift+T.
Control	: Combination with the "Ctrl" key Example: Ctrl+T.
Alt	: Combination with the "Alt" key Example: Alt+T.

Tip

All keyboard shortcuts and their actions that are configured in the visualization are listed on the Keyboard Configuration tab.

Access Rights

Note

Available only when a user management is set up for visualization.

Access Rights button

Opens the Access Rights dialog. There you can edit the access privileges for the element.

. Status messages:

Not set. Full rights.: Access rights for all user groups : operable
Rights are set: Limited rights: Access is restricted for at least one group.